home *** CD-ROM | disk | FTP | other *** search
/ Workbench Add-On / Workbench Add-On - Volume 1.iso / DiskUtil / Misc / BTNTape / doc / install.doc < prev    next >
Text File  |  1994-04-03  |  17KB  |  329 lines

  1. This section of the BTN documentation discusses how to install and configure
  2. the BTN software on your system.
  3.  
  4. ****    BTNtape:  an AmigaDOS handler for SCSI tape drives
  5. ****       Version 3.0  3/14/94
  6. ****       Freeware by Bob Rethemeyer   (drBob@cup.portal.com)
  7. ****    (c) Copyright 1990, 1994  Robert Rethemeyer.
  8.  
  9.  
  10. INSTALLATION:
  11.  
  12.   1.  Copy the BTN-HANDLER file to L:
  13.       Copy the TAPEMON file to C: or a directory appropriate for you.
  14.  
  15.  
  16.   2.  Create an entry in DEVS:MOUNTLIST something like this:
  17.  
  18.        TAPE: Handler = L:btn-handler
  19.              Priority = 5
  20.              Stacksize = 4000
  21.              Mount = 1            /* optional. see CBM docs */
  22.              GlobVec = -1
  23.              Startup = "yourscsi.device/AA-x/BB-x/..." /* EXPLAINED BELOW */
  24.        #
  25.  
  26.       The most important line in the mountlist entry is the "Startup=" line.
  27.       This line is discussed fully below.
  28.  
  29.       There is nothing magic about the name TAPE:   You may use some
  30.       other valid device name if you like.  You may also create and mount
  31.       more than one device using the same physical tape drive but different
  32.       names and different startup parameters, provided you do not try to
  33.       access them simultaneously. (Example: you could have both a TAPERW: for
  34.       reads and writes, and a TAPERO: which is read-only using the AO flag.)
  35.  
  36.  
  37.   3.  Install the handler in DOS using the CLI command "MOUNT TAPE:"
  38.       NOTE: I recommend you use only the Commodore version of MOUNT.
  39.       I cannot guarantee BTN will work with any other mount variants.
  40.  
  41.       If there is a problem during mounting, BTN will put up a requester with
  42.       one of the following brief explanatory messages:
  43.  
  44.        "Can't open SCSI-direct"   - OpenDevice("yourscsi.device") failed.
  45.                                      Possibly due to misspelled device name
  46.                                      or wrong case (name is case sensitive).
  47.                                      Or driver doesn't recognize device,
  48.                                      may have been powered off at boot time.
  49.        "Can't select tape drive"  - Problem with drive, SCSI bus, or adapter.
  50.                                      SCSI device is not talking or has a
  51.                                      serious error.
  52.        "UNit is not a tape drive" - UN is wrong; may be pointing to a disk.
  53.  
  54.       Once you click the requester, BTN will terminate. You can then remedy
  55.       the problem, reboot (or use the ASSIGN command with REMOVE or DISMOUNT
  56.       to get rid of the dead device), and try again.
  57.  
  58.   4.  Run the TapeMon program.  This step is not essential, but while
  59.       you are learning to use BTN, it will be very helpful if you can
  60.       see what is going on.  And if you encounter an error, you will want
  61.       to know what happened and what was going on at the time.
  62.  
  63.  
  64. THE STARTUP PARAMETERS
  65.  
  66.       The mountlist Startup string is used by the handler to determine how
  67.       to access your drive.  FAILURE TO ENTER PROPER INFORMATION IN STARTUP
  68.       MAY RESULT IN PROBLEMS INCLUDING HANGS, VISITS FROM THE GURU,
  69.       OR DATA LOSS.  This is the ugliest part of installing.  Pay attention.
  70.  
  71.       The Startup string must be in the form:
  72.  
  73.                Startup = "devicename/keyword-number/keyword-number/..."
  74.  
  75.       It must not have any embedded blanks and must be enclosed in quotes.
  76.       Each parameter must be separated by slashes.
  77.  
  78.       The first parameter must be the name of the device driver which provides
  79.       the SCSI-direct command interface.  Do not include any path information.
  80.       This name is defined by the manufacturer of your SCSI adapter.
  81.       (If you don't know what it is, use a utility like XOPER, TASKX, or ARTM
  82.       to look at the list of running tasks, and make a guess.)
  83.       You MUST use the exact same upper and lower case letters (this is a DOS
  84.       restriction).  The driver names for the adapters I know about are:
  85.  
  86.         All Commodore machines and adapters (A2091, A590, A3000, etc.)
  87.            except A2090A -> scsi.device
  88.         Commodore A2090A -> hddisk.device
  89.         Supra            -> suprascsi.device   (Series III v3.0 and above)
  90.         GVP              -> gvpscsi.device
  91.         HardFrame        -> HardFrame.device
  92.         Nexus            -> Nexus.device  (NOT NexusTape.device!)
  93.         Trumpcard        -> IVS_SCSI.device
  94.         Trumpcard Pro    -> IVS_SCSIpro.device
  95.         ICD Advantage    -> icddisk.device
  96.         Xetec            -> harddisk.device
  97.         Ashcom           -> ADD_scsi.device
  98.  
  99.       The name parameter MUST be the first item in the string.  All other
  100.       parameters may be in any order, but the name must be first.
  101.  
  102.       The remaining items consist of pairs of two-letter keywords and a number
  103.       separated by a dash (minus sign).  The keywords are explained below.
  104.       You may omit any of them (except UNit), and a default value will be
  105.       assumed.  The numbers may be decimal, or hex in the "0xNN" format.
  106.  
  107.  
  108.       UNIT     Keyword: UN    Default: none
  109.       -------------------------------------
  110.         The unit number of your tape drive, as it will be addressed
  111.         by your hard disk driver.  Usually you can just specify the
  112.         SCSI bus ID.     Example: "UN-4" for 4.
  113.         More complex setups may require the form "UN-BLI",
  114.         where B=board#, L=logical_unit#, and I=SCSI_bus_ID.
  115.         (Example: UN-123 is board=1, lun=2, ID=3)
  116.         Be sure you have set the drive's ID switches or jumpers
  117.         to a value that is unique on the SCSI bus.  (Remember, the
  118.         adapter in your machine also has an ID, which is usually 7.)
  119.         (2090A owners- add 3 to the physical ID number.)
  120.  
  121.       BLOCK SIZE     Keyword: BS    Default: BS-512
  122.       ---------------------------------------------
  123.         The number of bytes in a SCSI logical block for
  124.         your tape drive.  Consult your drive documentation.
  125.         If you don't know this info, try 512, the most common value.
  126.         (See the hardware.doc file for the values to use with 3M drives.)
  127.         Some drives allow you to specify different block sizes, within
  128.         a legal range;  the handler will command the drive to use the
  129.         size you specify.  Others can use only one fixed size. If your
  130.         drive can use different block sizes, you must use the same size
  131.         when reading a tape as you did when writing it.
  132.  
  133.       NUMBER OF BLOCKS  Keyword: NB    Default: NB-1
  134.       ----------------------------------------------
  135.         The number of SCSI logical blocks to write or read in each
  136.         tape operation.  This is a performance adjustment only.
  137.         Use what works best for you.  Most drives will be mechanically more
  138.         efficient writing multiple blocks.  You may want to tweak this
  139.         parameter to find out.  The handler will wait until NB blocks have been
  140.         accumulated before starting a write.   Buffered drives will also have a
  141.         limit on the number of blocks the buffers can hold, so the size of NB
  142.         relative to that number may have an effect.  Consult your drive docs.
  143.         This parameter also determines how much memory is needed for
  144.         buffers.  The handler uses double buffering, so it will need
  145.         2 * BS * NB bytes when you Open() it.
  146.         For example, if BS=8192 and NB=8, then 8192*8 = 64K,
  147.         doubled for a total of 128K.
  148.  
  149.       BUFMEMTYPE   Keyword: BT    Default: BT-0
  150.       -----------------------------------------
  151.         The type of memory to allocate for the tape buffers,
  152.         same as BufMemType for mountlists.  Use 0 or 1 for "any",
  153.         2 or 3 for "chip", 4 or 5 for "fast".
  154.  
  155.       FILEMARKS    Keyword: FM    Default: FM-1
  156.       -----------------------------------------
  157.         Specifies number of filemarks to write when closing at the
  158.         end of a write, or the number to skip for each file when
  159.         opening for read.  FM-1 (the default) is recommended.
  160.         FM-0 means no filemarks are written, and read references
  161.         to TAPE:num become the equivalent to TAPE:R.
  162.         Allowed range is 0-255.  Sequential drives only.
  163.  
  164.       RETENSION flag   Keyword: RT    Default: RT-0
  165.       ---------------------------------------------
  166.         If RT-1 is specified, the handler will retension the tape
  167.         (run to the end of the tape and back) on the first access
  168.         after a new tape is inserted (indicated by Unit Attention
  169.         status).  Specify RT-0 (or omit it) if your drive already
  170.         does this automatically, or does not support the necessary
  171.         SCSI command, or if you don't want it.
  172.         *Note*  Some SCSI adapters, such as GVP and IVS, may
  173.         periodically poll the drive for readiness, which has the effect
  174.         of losing the the Unit Attention status.  A clue: the light
  175.         on the drive may blink every few seconds.   For such
  176.         adapters, the RT function will not work;  use tape.rexx.
  177.  
  178.         X  VARIABLE BLOCK flag    Keyword: VB    Default: VB-0
  179.         X  ---------------------------------------------------
  180.         X  SORRY, this feature has never worked right, and I don't
  181.         X  have the means to fix it now, so it has been disabled.
  182.         X  If you think you really need it, use BTN version 2.1.
  183.         X    The handler normally operates sequential
  184.         X    drives in fixed block mode.  Specifying VB-1 will force
  185.         X    operation in variable block mode instead.  Use this
  186.         X    if your drive does not support fixed block mode or
  187.         X    you for some reason need variable block mode.
  188.  
  189.       RESERVED BLOCKS   Keyword: RB    Default: RB-0
  190.       ----------------------------------------------
  191.         For direct access (3M) drives only.  Specifies how
  192.         many blocks to skip at the beginning of the tape.
  193.  
  194.       DEVICE FLAGS   Keyword: DF    Default: DF-0
  195.       -------------------------------------------
  196.         Equivalent to the Flags parameter in mountlists.
  197.         It is passed in the OpenDevice() call to open the SCSI-
  198.         direct driver. If you don't already know what you would use
  199.         this parameter for, then you probably don't need it.
  200.  
  201.       NO-REWIND flag   Keyword: NR    Default: NR-0
  202.       ---------------------------------------------
  203.         Controls rewinding behavior when referencing TAPE: .
  204.         Set this flag according to your personal preference.
  205.         If NR-0, reference to TAPE: is equivalent to TAPE:R.
  206.         If NR-1, reference to TAPE: is equivalent to TAPE:NR.
  207.         See "usage.doc" for what these mean.
  208.  
  209.       REWIND-ON-CLOSE flag   Keyword: RC    Default: RC-0
  210.       ---------------------------------------------------
  211.         Specify RC-1 to cause BTN to rewind the tape whenever
  212.         it is closed after reading or writing.  Set this flag
  213.         according to your personal preference.
  214.  
  215.       EJECT-ON-CLOSE flag   Keyword: EC    Default: EC-0
  216.       --------------------------------------------------
  217.         Specify EC-1 to cause BTN to eject the tape whenever
  218.         it is closed after reading or writing.  Set this flag
  219.         according to your personal preference.  You may also
  220.         use tape.rexx to manually cause this function at any time.
  221.         Note- some drives are not capable of a programmed eject.
  222.  
  223.       READ-ONLY flag        Keyword: RO    Default: RO-0
  224.       --------------------------------------------------
  225.         If you specify RO-1, the handler cannot be opened for
  226.         write operations.  You may use this as protection
  227.         against accidental data loss in cases where you know
  228.         you will only be reading tapes.  When you do not
  229.         use this mode, you can still write-protect tapes
  230.         individually using the write-protect tab on cartridge.
  231.         NOTE- this mode will not protect the tape from data loss
  232.         by the use of RAW commands.  See also features.doc file.
  233.  
  234.       APPEND-ONLY flag      Keyword: AO    Default: AO-0  (Sequential only)
  235.       --------------------------------------------------
  236.         This flag activates a safety mode in the handler that helps
  237.         prevent accidentally writing over files that already exist
  238.         on the tape.  When AO-1 is specified, you may only open
  239.         the handler for writing using TAPE:APP or TAPE:END, and also
  240.         TAPE:NR if you are currently positioned at the end of data.
  241.         The result is that you are only allowed to add files to the
  242.         end of the tape, and cannot overwrite earlier files.
  243.         This feature has no effect when reading files.
  244.         NOTE- this mode will not protect the tape from data loss
  245.         by the use of RAW commands.  See also features.doc file.
  246.  
  247.       ERROR RECOVERY flag   Keyword: ER    Default: ER-0
  248.       --------------------------------------------------
  249.         Specify ER-1 to cause BTN to display a requester whenever
  250.         a device error occurs during a read or write operation.  The
  251.         requester gives you the choice "IGNORE" or "FAIL".  If you
  252.         choose FAIL (or ER=0), the error status is returned to the program.
  253.         (This was the default behavior of earlier BTNs, which did not have
  254.         this flag).  If you choose IGNORE, BTN forces the program to
  255.         receive good status, even though data in the affected buffer may be
  256.         partially or completely lost.  For reads, this may allow
  257.         TAR to skip bad blocks and read the remainder of the archive.
  258.  
  259.       MOUNT-REQ-BYPASS  Keyword: MR    Default: MR-0
  260.       ----------------------------------------------
  261.         Some versions of the MOUNT command may cause a system requester
  262.         to appear if there is no tape in the drive or if it is
  263.         write-protected.  If your MOUNT does this, specify MR-1
  264.         to avoid this nuisance requester.  It is always safe to
  265.         use the default MR-0, but do not specify MR-1 unless you
  266.         are sure that your version of MOUNT causes a requester with MR-0.
  267.         If you use MR-1 with a MOUNT version that does not cause a
  268.         requester, your system will crash!
  269.  
  270.       SWAP-BYTES flag   Keyword: SW    Default: SW-0
  271.       ----------------------------------------------
  272.         Specify SW-1 to cause BTN to swap the order of each pair
  273.         of data bytes when going to or from the tape.  This
  274.         mode of operation should only be used when you wish to
  275.         read or write tapes for use on some workstations which
  276.         expect swapped bytes. (perhaps infested by Intel inside?)
  277.         This flag reduces performance.  Most people don't need it.
  278.  
  279.       OVERLAPPED I/O flag    Keyword: OV    Default: OV-1
  280.       ---------------------------------------------------
  281.         The handler normally (OV-1) attempts to overlap
  282.         tape drive I/O and DOS I/O to maximize throughput.
  283.         Specifying OV-0 disables overlapping and double buffering,
  284.         for systems that can't walk and chew gum at the same time.
  285.  
  286.       DEBUG flag        Keyword: DB    Default: DB-0
  287.       ----------------------------------------------
  288.         DB-1 causes the handler to print the data for all DOS packets
  289.         it receives and all replies it returns.  It only works when
  290.         the handler has been compiled with the DBUG symbol defined.
  291.  
  292.       X SUPRA flag   Keyword: SU      DELETED!!!!
  293.       X -----------------------------------------
  294.       X   The Supra Series II v1.10 circumvention has been removed
  295.       X   from BTN, due to a deficiency in the old Supra driver.
  296.       X   You now have no excuse- upgrade to the Series III driver!
  297.  
  298.       CBM 2090A flag   Keyword: C9    Default: C9-0
  299.       ---------------------------------------------
  300.         Activates the circumvention for the Commodore 2090A problem.
  301.         Specify C9-1 to activate this.   See "hardware.doc" file!
  302.  
  303.  
  304. EXAMPLES
  305.  
  306.       Here are some examples of valid Startup strings:
  307.  
  308.         Startup = "scsi.device/UN-4"   /* this is the bare minimum */
  309.  
  310.         Startup = "gvpscsi.device/BS-512/NB-128/UN-4/RT-1"
  311.  
  312.         Startup = "suprascsi.device/un-4/bs-8192/nb-8/bt-1"
  313.  
  314.  
  315. A QUICK FUNCTIONALITY TEST
  316.  
  317.      Before jumping into disk backups and restores, try the following
  318.      simple test to see if your setup is basically working.
  319.      Write a large ASCII text file to the tape and see if you can
  320.      can read it back intact.  This can be done with the CLI TYPE command:
  321.  
  322.              TYPE filename TO TAPE:     ; writes the file to tape
  323.      then... TYPE TAPE:                 ; reads the file back
  324.  
  325.      The second TYPE should legibly print the ASCII file on your screen.
  326.      (If using a direct access drive, there is no filemark to signify
  327.      the end of the file, so use control-C to abort the second TYPE).
  328.  
  329.